Getting YUIDoc working and generating API documentation#280
Open
Jimgskoop wants to merge 2 commits intoDroppe:masterfrom
Open
Getting YUIDoc working and generating API documentation#280Jimgskoop wants to merge 2 commits intoDroppe:masterfrom
Jimgskoop wants to merge 2 commits intoDroppe:masterfrom
Conversation
Contributor
Author
|
@Iheartweb Should I add some of these files to the .gitignore? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added YUIDoc NPM requirements to package.json.
Set up yuidoc generation task in grunt.
Fixed a lot of the documentation blocks within the code to work as best as possible within YUIDoc -- YUIDoc has no concept of decorators, for example, so I used the @uses keyword to indicate the decoration relationship. I also had to rename the decoration code in scripts/decorators/state.js to "genericStateDecorator" because it was conflicting with "stateDecorator" from scripts/components/button/decorators/state.js.
To generate the documentation, do "npm install" and then execute "grunt yuidoc". Output is in docs/yuidoc.